Bentley i-model Composition Server for PDF Help

Advanced Configuration Properties

Advanced configuration properties that affect the default working behavior of Bentley i-model Composition Server for PDF can be edited through the Edit Advanced Configuration dialog.

To open this dialog:

  1. Open Orchestration Framework Administrator and connect the Bentley iCS for PDF Browser to the database.
  2. In the Bentley iCS for PDF Browser, under Configuration, right-click Advanced and select Edit Configuration).

The properties that you see in the right column of this dialog are initially set through the configuration wizard that opens during Bentley i-model Composition Server for PDF installation. You can change these properties here, in the Edit Advanced Configuration dialog, or by re-running the configuration wizard and clicking Next until you get to the Advanced Server Configuration Properties page (see Rerunning the Configuration Wizard After Installation).

The properties that you see in the left column of this dialog are additional configuration properties that can only be changed through the Edit Advanced Configuration dialog.

Left column properties

SettingDescription
Auto Start Job Default Interval (min) The default Auto Start interval for jobs for which Auto Start is enabled.
Create Audit Records If True (default), Bentley i-model Composition Server for PDF audit records are added to the source document when it is extracted and when renditions from it are distributed.
Enable Advanced Job Properties Set this property to True if you want to display the Incremental Settings tab on the Job Builder dialog. This tab is hidden by default.
Enable Office Attribute Exchange If True, attribute exchange is performed on Microsoft Office documents during extraction. This feature requires a supported version of Microsoft Office to be installed on the Bentley i-model Composition Server for PDF computer.

The default is False.

Extensions Requiring Copy Out A semicolon-separated list of file extensions (without the dot) identifying which Microsoft Office documents should be copied out instead of exported when documents are extracted. This property is used only if Office attribute exchange is enabled. Documents must be copied out in order for Office attribute exchange to occur.

Export operations are generally faster and less prone to concurrency failures than Copy Out operations. If Office attribute exchange is disabled or the document file extension is not one of those listed in this property value, extraction is always accomplished using export.

The default list of extensions is: doc;docx;xls;xlsm;xlsx

Culture Name Used to control the appearance of the date/time values in the job email notification without modifying the Windows regional settings of the operating system.

The current Windows regional settings are used by default (Culture Name=Default). To use something else, you can set the value to any culture name string that can be passed to the CultureInfo constructor. A list can be found here in the Language Tag column. If an invalid culture name is specified, the current Windows regional settings are used.

Enable Pending Distributions If True (default), distribution of source documents having multiple versions is deferred until all extractions and renditions are complete. This ensures that distributions associated with older source versions are never created on top of distributions associated with more recent source versions, which might otherwise occur in high-volume orchestrations performing simultaneous processing.

Setting this property to False can improve performance, but should only be done if your jobs only ever contain one version of a source document.

Job History Retention Max Days The maximum number of days to retain job history in the database. Job history records older than this period are deleted before adding a new job history record. If set to zero, job history records are never deleted.

The default is 90 (keep job history for 90 days).

Job History Include Up-to-Date When True (default), a row is added to the job history table and an email notification is sent for all stored job runs, including those run in incremental mode for which no document processing was required.

Set this property to False if you want to disable history recording and email notification for up-to-date job runs. For example, you might want to set this to False if you are frequently running a large number of jobs in incremental mode.

Match Documents by File Name Controls whether Bentley i-model Composition Server for PDF matches documents by document name or file name, when determining whether to create a new document, overwrite an existing document, or create a new version of an existing document in the destination folder.

When this setting is set to True (default), Bentley i-model Composition Server for PDF checks to see if there is already a document with a matching file name in the destination folder.

When this setting is set to False, Bentley i-model Composition Server for PDF checks to see if there is a document with a matching document name in the destination folder.

Max Document Rows in Email Sets the maximum number of document rows that can be included in the job email notification message. If set to zero, there is no limit.

The default is 500.

Enable Email Web URLs Set this property to True if you want ProjectWise Web document links to be included in the email notification and job history XML file for source and distribution documents. By default, only ProjectWise Explorer document links are included.
Require Folder Creator Full Control If True, and a job requires Bentley i-model Composition Server for PDF to create new folders in the destination datasource, the ProjectWise user who submitted the job must have Full Control permissions in addition to the permissions of the parent folder.

If False (default), the newly created folder always only inherits the permissions of the parent folder, which can result in distribution failures if the parent folder permissions do not give write access to the submitting user.

Reference Extensions to Ignore Add the file extensions (including the dot) to this semicolon-separated list to identify which reference document file types to never extract and to ignore when determining if a master document needs to be re-processed. For example, you might choose to add the point cloud extension (.POD) to this list if your point cloud references happen to be on non-printing levels and do not affect the rendition. Adding file extensions to this list has the potential to improve performance, but should only be done if you know that the file extension you are adding is never going to be used in the rendition.
Serial Number Attribute Map If False (default), serial number attributes are excluded from rendition attribute mapping. For environments containing document codes with serial number attributes, each distribution document receives a new serial number and thus a new document code.

If True, the serial number attribute values are copied just like any other attribute type.

Time Zone Lets administrators control the time zone in the job email notification without modifying operating system settings. The default value is Default, meaning the time zone on the server will be used.

If needed, this property can be set to any ID string that can be passed to the TimeZoneInfo.FindSystemTimeZoneById method. The list of valid IDs can be found in the Windows registry, as subkeys under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. The TimeZoneInfo ID controls both the base UTC offset and whether DST is in effect for the given day. If an invalid time zone ID is specified, the current Windows TimeZoneInfo is used.

Update Titleblocks in References If False (default), MicroStation and AutoCAD attribute exchange is only performed for the master document.

In order for attribute exchange to occur, the file must be opened in read-write mode. When Bentley i-model Composition Server for PDF is configured with multiple InterPlot processors, if two or more processes simultaneously attempt to open the same reference in read-write mode, all but one will fail and cause rendition errors. Since Bentley i-model Composition Server for PDF is commonly set up for high-volume concurrent processing, and placing title blocks inside references is not a typical workflow, the default behavior is to minimize the chance of failure by not performing attribute exchange inside references.

You can safely set this property to True if Bentley i-model Composition Server for PDF is configured to use a single InterPlot processor.

Use Version Attribute Value If True (default), when populating document code component attribute values for New Version deliverable documents, Bentley i-model Composition Server for PDF will copy existing values from the previous document version if a non-empty new value is not supplied via attribute mapping. In other words, new distribution versions inherit attribute values from the previous version in the distribution document series for all attributes whose value from rendition attribute mapping is undefined or an empty string.

If the user prefers that empty or undefined values from rendition attribute mapping override the inherited value from a previous version (which may result in a document code error), that behavior can be achieved by setting this property to False.

Version Name Conflict Behavior Specifies the behavior when Bentley i-model Composition Server for PDF attempts to create a document in the destination datasource with a specific version name (copied from the source document) if a document having that same name, file name, and version string already exists. The property value can be one of the following:
  • Skip without reporting error - Do nothing and do not fail the source document.
  • Report error - Do nothing and fail the source document.
  • Generate unique version name (default) - Append a new version to the destination document having a unique version name that does not match that of the associated source document version. This is done by appending ".0", ".1", and so on, to the source version name.

Right column properties

SettingDescription
Delete Job Folder on Completion If False (default), the job folder under the Bentley i-model Composition Server for PDF working directory is kept after the job completes. Change this setting to True if you want the job folder to be deleted automatically after the job completes.

Deleting the job folder reduces the storage space requirements on the server, but also forces all references to be re-extracted during incremental job runs. Deleting the job working folder also prevents ProjectWise delta file transfer optimization.

Keeping the job folder between job runs may improve performance depending on the number and size of the extracted documents. Setting this property to True can be helpful if storage space on the server is limited, or if security of the Bentley i-model Composition Server for PDF working directory is a concern, or if the job input set changes frequently or does not contain many large shared references.

Note: This property only affects the behavior of jobs created from Bentley i-model Composition Server Administrator. For jobs submitted from ProjectWise Explorer, the job folder is always deleted automatically when the job is complete.
Enable Automatic Job Start If True (default), the Auto Start feature is enabled on the server, which allows you to enable and configure Auto Start for any new or saved job in Bentley i-model Composition Server Administrator.

If False, you cannot enable auto start for any job.

See Running Jobs Automatically Using Auto Start.

Auto Start Job Minimum Interval (min) Sets the minimum Auto Start interval for a job for which Auto Start is enabled. This value can affect how frequently the Auto Start background task is executed.
Enable Health Monitor Enables a background task that can be used to monitor for certain conditions on the Bentley i-model Composition Server for PDF server, such as too many iplotorg.exe processes. Works in conjunction with work-in-progress prototype health notification service.
Enable High Security Used to control whether or not executable files (EXEs and DLLs) that might be included in a job's input set are deleted upon detection. Also controls whether or not InterPlot Organizer and its child PowerPlatform engines are launched in high security mode.

If needed, you can set this setting to False if you want to allow executable files in the input set to be copied out instead of deleted, or if you do not want InterPlot Organizer and its child PowerPlatform engines to be launched in high security mode.

Enable Job Priority When True (default) jobs submitted from ProjectWise Explorer are given priority over jobs created in Orchestration Framework Administrator.
Enable Progressive Input Processing Sets whether or not document processing is allowed to begin before the entire input set is scanned.

When True (default), document processing is able to begin before scanning of the entire input set is complete. This is intended to improve performance, especially for incremental jobs where the number of documents requiring processing is small compared to the total size of the input set. The only downside here is that the job monitor in Orchestration Framework Administrator cannot display accurate progress bars until the input set scan is complete.

Enable Queue Balancer When True (default), a Bentley i-model Composition Server for PDF background task periodically examines the queue counts for all processing nodes of the same type. If the queue counts get too far out of balance, the background task temporarily pauses the queues and moves messages among them to restore balance. Set this property to False if you need to disable this behavior.
Enable Rendition Failure Retry If True (default), in the event of an error during rendition creation, Bentley i-model Composition Server for PDF silently re-attempts the operation once without reporting an error while within the same MSMQ message processing attempt. This improves the probability of success in the presence of transient, unreproducible renditioning errors that can arise on heavily burdened servers.

Note that there are two retry actions that might occur:

  1. A single-retry inner loop inside IplotProcessor in the context of the same MSMQ message (controlled by this property). If the message processing is completed successfully on the second attempt, time was saved by not having to perform all the steps needed to prepare for iplotorg.exe launch. Most random failure recoveries benefit from this.
  2. One or more outer retry loops defined by how many times IplotProcessor is allowed to reprocess the same MSMQ message in the event of failure.

By default, in the worst case scenario (for example an invalid format DGN) four attempts will be made to create a rendition: two inner loop attempts that end up failing the MSMQ message, then two more inner loop attempts resulting from the second processing of the MSMQ message. If the number of rendition failures encountered is high enough to significantly affect job throughput, setting this property to False will reduce the number of attempts by half.

Enable Shortest Queue Detection If True (default), on an orchestration instance has more than one of a particular processor installed, the dispatcher will send messages to the processor that has the fewest messages in its queue. When set to False (not recommended), the system uses a simple algorithm to determine which processor to send the message to.
Enable Datasource Config via Web If True (default), administrators who use a web connection to connect to the database can view and edit configuration properties. Change this property to False if you want to prevent web-connected iCS Admin users from being able to view or edit configuration properties.
Input Set Limit Used to put a limit on the number of documents in the input set that will be processed. If zero (default), there is no limit.

Setting this property can prevent overly large job runs due to unintended expansion of saved searches producing very large numbers of results. In the event the input set limit is exceeded, the job run proceeds without error with the maximum number of documents.

Max Renditions Before Restart Used to put a limit on the number of renditions in a job that an InterPlot processor will create using a single InterPlot Organizer worker process before the InterPlot processor is restarted. When set to zero (default), there is no limit of renditions in a job that an InterPlot processor will create using a single InterPlot Organizer process.

While setting a limit might reduce performance, it also reduces the chance of failure when creating large numbers of renditions within a single job.

Enable Job Logging By default, Bentley i-model Composition Server for PDF creates a job log XML file in C:\ProgramData\Bentley\Bentley iCS for PDF\JobLogs\ for every job run.

Each individual job log file name follows the pattern <JobID>_<UTC job start date & time>_<UTC job end date & time>_<S or E depending on whether the job was completely successful or contained errors>.xml.

Job Log Include Document Details When False (default), the individual job log XML files in the job log folder only contain summary information about the job run. If set to True, details about each source master document and distributed document are included in the file.
Job Log Retention Max Days By default, all files in the job log folder older than 30 days are automatically deleted. Use this property to change the retention period as needed. Set this property to zero if you want to keep the job log files indefinitely.
InterPlot AddPlot Timeout (sec) The amount of time in seconds that an InterPlot Organizer "AddPlot" command can run before it times out.

The default is 1800 seconds (30 minutes).

The AddPlot command includes the act of downloading the managed configuration (if needed), starting the PowerPlatform engine (if not already running), loading the master design file, and collecting design state information. It does not include the time required to create the rendition file, which could take much longer depending on the design file and rendition settings.

The short default timeout period defined by this property allows the IplotProcessor to react quickly to any hangs that might be encountered during managed configuration download or PowerPlatform engine startup.

Note: The time that the IplotProcessor is allowed to process an entire MSMQ message (both AddPlot plus rendition time for a single master design file) is 60 minutes plus one allowed retry in the event of failure - a maximum of 2 hours per message. This longer timeout period for the IplotProcessor is required to support the rendition times for large, complex design files and/or rasterized renditions.
ProjectWise Login Timeout (sec) The amount of time in seconds that a ProjectWise login attempt is allowed to take before it times out.

The default is 120 seconds (2 minutes).

The short default timeout period defined by this property allows Bentley i-model Composition Server for PDF to react quickly to any hangs that might be encountered during datasource login.

InterPlot Printer Name Enter a name here if you want to override the name of the Windows printer on the server used by InterPlot Organizer when creating renditions. The printer name is normally specified by the IP_DCS_RENDITION_PRINTER configuration variable in IP.CFG to be "ProjectWise Dynamic Composition Server" (an old name for the product).

The InterPlot printer used on the server determines which paper sizes are available when creating renditions. For organizations that use InterPlot Organizer in conjunction with a vendor-provided printer driver that uses non-standard paper size names, it might be necessary to install that printer driver onto the Bentley i-model Composition Server for PDF server, and to specify that printer name in this property, in order to use the same InterPlot settings file in the rendition profile as they use with interactive InterPlot Organizer.